Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add a simple CHANGELOG.md that references GH releases #419

Merged
merged 1 commit into from
Sep 6, 2022

Conversation

agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented Sep 4, 2022

Summary

Add a CHANGELOG.md that references the release notes on GH Releases

Details

  • we have release notes already in GH releases, so add a simple CHANGELOG.md that references it

    • I use something similar in most of my libraries
  • this should hopefully make it easier for users to find the release notes in case they hadn't seen them on GH before

- we have release notes already in GH releases, so add a simple `CHANGELOG.md` that references it
  - I use something similar in most of my libraries

- this should hopefully make it easier for users to find the release notes in case they hadn't seen them on GH before
@agilgur5 agilgur5 added scope: docs Documentation could be improved. Or changes that only affect docs kind: dx Improvements to dev experience, e.g. error messages, logging, external-facing docs, etc labels Sep 4, 2022
@ezolenko ezolenko merged commit e98e0ed into ezolenko:master Sep 6, 2022
@agilgur5 agilgur5 deleted the docs-add-changelog-ref branch July 2, 2023 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind: dx Improvements to dev experience, e.g. error messages, logging, external-facing docs, etc scope: docs Documentation could be improved. Or changes that only affect docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Could the project please publish a changelog?
2 participants